<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::ParticleGenerator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_particle_generator.html">ParticleGenerator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_s_p_h_1_1_particle_generator-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::ParticleGenerator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Base abstract class for particle generation.  
 <a href="class_s_p_h_1_1_particle_generator.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="base__particle__generator_8h_source.html">base_particle_generator.h</a>&gt;</code></p>

<p>Inherited by <a class="el" href="class_s_p_h_1_1_particle_generator_direct.html">SPH::ParticleGeneratorDirect</a>, and <a class="el" href="class_s_p_h_1_1_particle_generator_lattice.html">SPH::ParticleGeneratorLattice</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a527eb9d8e12fb80f4bd27c10a7c32b37"><td class="memItemLeft" align="right" valign="top"><a id="a527eb9d8e12fb80f4bd27c10a7c32b37"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ParticleGenerator</b> (<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> &amp;body)</td></tr>
<tr class="separator:a527eb9d8e12fb80f4bd27c10a7c32b37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8d3b87e02aaf2c2f61068185381b008"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_particle_generator.html#ad8d3b87e02aaf2c2f61068185381b008">CreateBaseParticles</a> (<a class="el" href="class_s_p_h_1_1_base_particles.html">BaseParticles</a> *base_particles)=0</td></tr>
<tr class="separator:ad8d3b87e02aaf2c2f61068185381b008"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a7e6df0c87aaf21b530d726bd7b994778"><td class="memItemLeft" align="right" valign="top"><a id="a7e6df0c87aaf21b530d726bd7b994778"></a>
<a class="el" href="class_s_p_h_1_1_s_p_h_body.html">SPHBody</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>body_</b></td></tr>
<tr class="separator:a7e6df0c87aaf21b530d726bd7b994778"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base abstract class for particle generation. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad8d3b87e02aaf2c2f61068185381b008"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8d3b87e02aaf2c2f61068185381b008">&#9670;&nbsp;</a></span>CreateBaseParticles()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void SPH::ParticleGenerator::CreateBaseParticles </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_s_p_h_1_1_base_particles.html">BaseParticles</a> *&#160;</td>
          <td class="paramname"><em>base_particles</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Create lattice particle for a body. </p>

<p>Implemented in <a class="el" href="class_s_p_h_1_1_particle_generator_regularized.html#a0c473cd0265daec743912351e3006df2">SPH::ParticleGeneratorRegularized</a>, <a class="el" href="class_s_p_h_1_1_particle_generator_direct.html#a29a72383d4b3a004c277e05226ff64d0">SPH::ParticleGeneratorDirect</a>, and <a class="el" href="class_s_p_h_1_1_particle_generator_lattice.html#ae917563b010e911bb82068bc167a8562">SPH::ParticleGeneratorLattice</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SPHINXsys/src/shared/particle_generator/<a class="el" href="base__particle__generator_8h_source.html">base_particle_generator.h</a></li>
<li>SPHINXsys/src/shared/particle_generator/<a class="el" href="base__particle__generator_8cpp.html">base_particle_generator.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
